WIP: Spike "pseudo self serve" feature #2775
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It's hard to build a pretty or compliant form without the Design System. This commit (based on what's in Content Publisher) quickly hacks a layout we can use.
Adds an `/admin/:document_type_slug` path, which reads the config from the associated schema JSON file, and displays it in basic form inputs. Clicking "Generate schema" generates a JSON string which the user can copy and paste. In theory, this makes requesting edits to finders easier, as users can see the existing configuration, make tweaks, and then give us the tweaked configuration in a ready to use format. It also paves the way for self-serve in future, where we may want to automatically republish finders after edits.
We can still lean on the "generate a big blob of JSON we can copy and paste", while splitting the user experience up into more manageable chunks.
For local dev only Taking the same CSS and dependency as used in Travel Advice Publisher.
The linked form currently goes to Tech 2nd Line, but we will have it go to the publishing queue. See: https://govuk.zendesk.com/agent/tickets/5930911
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| <h2>Diff</h2> | ||
| <%= Diffy::Diff.new( | ||
| JSON.pretty_generate(@original_schema).to_s, | ||
| JSON.pretty_generate(@proposed_schema).to_s, |
Check notice
Code scanning / Brakeman
Unescaped parameter value. Note
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What and Why
Spikes adding a new form to Specialist Publisher, which reads an existing schema and represents it as form(s) with editable values. It then generates JSON which can be used to replace the schema.
The hypothesis is that publishers want to be able to tweak facet names, add facets, etc, and that our current process for making such requests is quite verbose and not well formulated. Whereas if they can provide all the values themselves in exactly the places they'll be needed, they can just give us the JSON and we can open a PR with it (then do all the due diligence around reindexing if the facet name changed, etc).
Longer term, it would also fairly easily pave the way for self-serve where reindexing isn't required (e.g. tweaking the name of the user-facing description, or changing the terms that are used only within Specialist Publisher's UI, etc).
The intention is for this to start off as "pseudo self serve". Departments would be able to make edits to this form, which (without too much extra work) could utilise Support API and generate a Zendesk ticket containing the JSON output, ready for a developer to action. In time, we could also swap out aspects of this for 'true' self-serve - and these 'edit' forms should also form the basis of a form be used for 'new' specialist finders, as opposed to just editing existing ones.
Screenshots
Screenshot of the new '/admin/:document_type' prefix landing page:
Screenshot of the 'edit metadata' form:
Screenshot of the current (temporary) output:
...including diffing:
Screenshot of the facets form:
Trello: https://trello.com/c/ZVtcDFL9/2856-spike-pseudo-self-serve-form-for-specialist-publisher
Follow these steps if you are doing a Rails upgrade.